home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / uhren & terminkalender / time / sclock / amigaguidedoc / sclock.guide (.txt) next >
Amigaguide Document  |  1996-04-07  |  23KB  |  504 lines
  1. @Database SClockguide
  2. @Node Main
  3. @Title "SClock V 1.72 by Rune Johnsrud"
  4.                         SClock V1.72 (DOC)
  5.                                 by
  6.            Rune Johnsrud / (c) 1994 Pork Soda Softworks
  7. ----------
  8. @{b}IMPORTANT:@{ub}
  9. ----------
  10. The author of this program is not in any way responsible for any
  11. damage caused by this software WHAT SO EVER!!!
  12. This version of SClock (and it's source code) is FREEWARE, so you
  13. can give it to anyone you want.  It should be distributed as
  14. FREEWARE, and anyone can include it in their PD library (or
  15. something similar), as long as they charge only a minor fee for
  16. copying, and as long as all the files in the archive accompany it
  17. (and the archive contents remains unchanged!!!).
  18. Fred Fish is also allowed to include this program in his excellent
  19. PD library.
  20. Computer magazines and other computer publications are NOT allowed
  21. to include it with their product without my written permission!!!!
  22. -------------------------------
  23. What do you need to use SClock:
  24. -------------------------------
  25. You will need:
  26.   * One (or more) Amiga(s) (!)
  27.   * A MC68020 processor (or higher),
  28.   * At least Kickstart V3.0 (V39) (or higher).
  29. Things you DON'T really need:
  30.   * Some nice fonts
  31.   * Some nice IFF/GIF/BMP/JPEG/PCX pictures...
  32. @{"    Getting started       " link Getting}  Getting started
  33. @{"    Using SClock          " link Using}  SClock
  34. @{"    Configuring Sclock    " link config}  Configuring SClock
  35. @{"    Tooltypes             " link tools}  Tooltypes
  36. @{"    Menus                 " link Menus}  Different Menus
  37. @{"    Errors                " link Errors}  Different Errors
  38. @{"    Misc                  " link misc}  Misc.
  39. @{"    Source                " link source}  Sourceinfo
  40. @{"    Last                  " link last}  Last words
  41. @{"    Readme first          " link README}  Readme first of all
  42. @{"    SClock tooltypes FULL " link Sc_tools}  Full description of tooltypes
  43. @endnode
  44. @node Getting "Getting started with SClock..."
  45. ----------------
  46. Getting started:
  47. ----------------
  48. To install this version of SClock, just copy the main executable
  49. (SClock), and one of the supplied icons (SClockAnalog.info,
  50. SClockDigital.info or SClock.info) to the desired directory and
  51. rename the chosen icon to Sclock.info if a MUI icon is used.
  52. (SClockAnalog.info has of course a default analog setup and
  53. SClockDigital.info a default digital setup.)
  54. This program is "A Workbench ONLY" program, so to be able to use
  55. it, it's important that the original icon (or a "similar" copy)
  56. accompanies the executable.
  57. @endnode
  58. @node using "Using SClock..."
  59. -------------
  60. Using SClock:
  61. -------------
  62. To start SClock just double click on it's icon, and if everything
  63. starts ok, a "window" that contains the current system time will
  64. appear. The appearence of the display window depends upon which of
  65. the two diplay types has been selected, "ANALOG" or "DIGITAL".
  66. If an error message appears or it just won't start, read on.
  67. To quit SClock, activate the clock window, and select the
  68. "Project/Quit" menu item, or press "Right Amiga Q".
  69. @endnode
  70. @node config "Configuring SClock..."
  71. -------------------
  72. Configuring SClock:
  73. -------------------
  74. SClock allows you to make a lot of changes to it's "original"
  75. appearance.  Just read on and you will find out more about the
  76. different configuration possibilities.
  77. All the different configuration possibilities are accessible
  78. trough the "SClock.info" icon file.  Use the Workbench
  79. "Icon/Information" program to edit the different tool types.  Some
  80. of the different configuration options are also accessible through
  81. the menu that accompanies the clock window.  (Click on the
  82. ClockWindow, press the right mouse button and a menu will appear).
  83. All the different tool type values have internal default settings,
  84. so if you REM away all/or some tool types the internal defaults
  85. will be used.
  86. @endnode
  87. @node tools "Tooltypes menu..."
  88. ---------------
  89. Tooltypes menu.
  90. ---------------
  91. @{"    Shared tooltypes      " link diff}  Shared tooltypes
  92. @{"    Digital tooltypes     " link digital}  Digital tooltypes
  93. @{"    Analog tooltypes      " link analog}  Analog tooltypes
  94. @endnode
  95. @node diff "Different tooltypes..."
  96. The different tool types are:
  97. -----------------------------
  98.     * DONOTWAIT
  99.         This will allow you to start SClock from the  WBStartup drawer.
  100.     * PUBSCREEN=<pubscreenname>
  101.         This allows you to start (put) the clock on any public
  102.         screen that is open.  The name must be spelled right
  103.         (case is IMPORTANT).  If no name is specified,
  104.         the Workbench screen (or default public screen) will
  105.         be used.
  106.         If it fails to open on the specified public screen,
  107.         it will display this error message:
  108.         "Couldn't lock specified public screen".
  109.         Check the "pubscreenname" you have specified,
  110.         and try again.
  111.     * CLOCKTYPE=<ANALOG|DIGITAL>
  112.         This option specifies what type of display you want.
  113.         The different options are: "ANALOG" or "DIGITAL".
  114.         Depending on what kind of "CLOCKTYPE" you have specified,
  115.         other different options might not work, and others may start
  116.         working. Look at the SClock_ToolTypes.DOC file too se which
  117.         tooltypes that are "active" when selecting the different
  118.         "CLOCKTYPE"'s.
  119.     * GLOBALFLAGS=<SHOWDATE|SHOWSEC|EDGEBEVEL|BACKDROPWIN|LOCKPOS>
  120.         This option allows you to define a bulk of general flags
  121.         (or settings).
  122.         SHOWDATE specifies if the current date should be
  123.         displayed.
  124.         SHOWSEC specifies if the seconds of the current time
  125.         should be dsiplayed.
  126.         EDGEBEVEL specifies if a bevel box should be drawn
  127.         around the time/date display.  (Colors/Pens used are
  128.         specified using the "SHINEPEN" and "SHADOWPEN"
  129.         tooltypes).
  130.         If this flag is not disabled, no bevel edge will be drawn.
  131.         This is especially useful together with the "BACKDROPWIN"
  132.         tooltype.
  133.         BACKDROPWIN specifies if the clock display is a
  134.         BACKDROPWINDOW or a normal window.
  135.         If you always want your clock display to stay at the
  136.         bottom, activate this tooltype.
  137.         LOCKPOS specifies whether you will be able to move the clock
  138.         display around or not.
  139.         To enable/disable the different options, do the following:
  140.                          DISABLED           DISABLED
  141.                             ||                 ||
  142.                              |                  |
  143.         GLOBALFLAGS=SHOWDATE|;SHOWSEC|EDGEBEVEL|;BACKDROPWIN|LOCKPOS
  144.                     |                 |
  145.                     ||                ||
  146.                  ENABLED           ENABLED
  147.     * LEFTPOS=<xpos>
  148.         This number specifies the leftmost position of the 
  149.         clock when it is started. Default is 0.
  150.         This option is also adjustable from SClock.
  151.     * TOPPOS=<ypos>
  152.         This number specifies the top position of the clock
  153.         window when it is started. Default is 0.
  154.         This option is also adjustable from SClock.
  155.     * WIDTH=<xsize>
  156.         The width of the "ANALOG" clock display window in pixels.
  157.         Default is 100, minimum is 50.
  158.     * HEIGHT=<ysize>
  159.         The height of the "ANALOG" clock display window in pixels.
  160.         Default is 100, minimum is 50.
  161.     * FONTNAME=<fontname.font>
  162.         This option specifies which font the time/date text
  163.         will be displayed with when the clock is started.
  164.         Default is "topaz.font".
  165.         If SClock fails to open the font, it will display
  166.         the following error message:
  167.         "Couldn't open specified font".
  168.         Check the specified font name, and try again.
  169.         This option is also "adjustable" from SClock.
  170.     * FONTSIZE=<ysize>
  171.         This option specifies the YSize of the font used.
  172.         Default is 8.
  173.         This option is also "adjustable" from SClock.
  174.     * TEXTPEN=<pen-number>
  175.         Specifies the pen number (colour number) that the time/date
  176.         text will be displayed with (range 0-255).
  177.         Default is 1.
  178.     * BGPEN=<pen-number>
  179.         Specifies the pen number (colour number) that the background
  180.         will be displayed with (range 0-255).
  181.         Default is 3.
  182.         If this tooltype is not present, no bevel edge will be drawn.
  183.         This is especially useful together with the "BACKDROPWIN"
  184.         tooltype.
  185.     * SHINEPEN=<pen-number>
  186.         Specifies the pen number (colour number) that the left/top
  187.         border will be displayed with (range 0-255).
  188.         Default is 2.
  189.     * SHADOWPEN=<pen-number>
  190.         Specifies the pen number (colour number) that the right/bottom
  191.         border will be displayed with (range 0-255).
  192.         Default is 1.
  193. Experiment with the different tool types to satisfy your personal taste.
  194. @endnode
  195. @node digital "Digital tooltypes..."
  196. DIGITAL Tooltypes:
  197. ------------------
  198.     * DIGITALFLAGS=<flags>
  199.         No flags are available in the present version 
  200.     * DATEFORMAT=<format-num>
  201.         This option specifies the format of the date display string.
  202.         Defalt is 0.
  203.         The different formats are:
  204.         Format 0: "dd.mmm.yyyy"     - Ex: 31.May.1993
  205.         Format 1: "dd.mmm.yy"       - Ex: 31.May.93
  206.         Format 2: "dd.mm.yyyy"      - Ex: 31.05.1993
  207.         Format 3: "dd.mm.yy"        - Ex: 31.05.93
  208.     * DATESEPARATOR=<separator-char>
  209.         This option specifies the character that will be used to
  210.         separate the Day/Month/Year strings. Default is ".".
  211.         Specifying a "-" char will produce a display like this:
  212.         "dd-mmm-yyyy" 
  213.     * DATESPACING=<num_of_chars>
  214.         This option specifies the amount of "blank" space that will
  215.         appear between the time and date display. Default is 2.
  216.     * TIMESEPARATOR=<separator-char>
  217.         This option specifies the character that will be used to
  218.         separate the Hour/Minute/Second numbers. Default is ":".
  219.         Specifying a "/" char will produce a display like this:
  220.         "hh/mm/ss" 
  221. Experiment with the different tool types to satisfy your personal taste.
  222. @endnode
  223. @node analog "Analog tooltypes..."
  224. ANALOG ToolTypes:
  225. -----------------
  226.     * ANALOGFLAGS=<PLACECLOCK|SHOWDIAL|AUTOSIZE>
  227.         This option allows you to define a bulk of Analog flags
  228.         (or settings).
  229.         PLACECLOCK specifies if the clockdial can be indipendantly
  230.         moved around inside the render box.
  231.         To control the exact placement, use the "CLOCKLEFT",
  232.         "CLOCKTOP", "CLOCKWIDTH" and "CLOCKHEIGHT" tooltypes.
  233.         Experiment with the settings and see what happens!!!!
  234.         SHOWDIAL specifies if the clock dial should be drawn or
  235.         not.
  236.         AUTOSIZE specifies if the clock display render box should
  237.         be automatically sized to fit any backdrop picture
  238.         selected (overides the "WIDTH" and "HEIGHT" settings).
  239.         To enable/disable the different options, do the following:
  240.                             DISABLED
  241.                                || 
  242.                                |
  243.         ANALOGFLAGS=PLACECLOCK|;SHOWDIAL|AUTOSIZE>
  244.                     |                    |
  245.                     ||                   ||
  246.                  ENABLED              ENABLED
  247.     * BACKDROP=<picture_name>
  248.         Specifies path/filename for any picture that you want as a backdrop
  249.         on your "ANALOG" clock display window.
  250.         The parsing of the pictures is done by datatypes, and only picture
  251.         types that you have datatypes for will be used and/or displayed.
  252.     * EDGESPACING=<pixels>
  253.         The number of pixels used as spacing between the display window
  254.         edge and the "edge" of the clock dial.
  255.     * MINXSCALE=<scale_factor>
  256.         The number specified is used as to define the X size of the large
  257.         5 min. indicator dots.
  258.     * MINYSCALE=<scale_factor>
  259.         The number specified is used as to define the Y size of the large
  260.         5 min. indicator dots.
  261.     * CLOCKLEFT=<x_pos>
  262.         This number specifies the left position of the clock dial inside
  263.         the display window when it is started. Default is 0.
  264.     * CLOCKTOP=<y_pos>
  265.         This number specifies the top position of the clock dial inside
  266.         the display window when it is started. Default is 0.
  267.         
  268.     * CLOCKWIDTH=<x_size>
  269.         The width of the clock dial in pixels.
  270.         Default is 50.
  271.     * CLOCKHEIGHT<y_size>
  272.         The height of the clock dial in pixels.
  273.         Default is 50.
  274.     * MINSMALLPEN=<pen-number>
  275.         Specifies the pen number that the small minute indicator
  276.         dots will be displayed with. Default is 1.
  277.     * MINLARGEPEN=<pen-number>
  278.         Specifies the pen number that the large 5 minute indicator
  279.         dots will be displayed with. Default is 3.
  280.     * SECPEN=<pen-number>
  281.         Specifies the pen number that the second indicator will be
  282.         displayed with. Default is 1.
  283.     * MINPEN=<pen-number>
  284.         Specifies the pen number that the minute indicator will be
  285.         displayed with. Default is 0.
  286.     * HOURPEN=<pen-number>
  287.         Specifies the pen number that the hour indicator will be
  288.         displayed with. Default is 0.
  289.     * DIALPEN=<pen-number>
  290.         Specifies the pen number that the clock dial will be
  291.         displayed with.
  292.     * DIALOUTILINEPEN=<pen-number>
  293.         Specifies the pen number that the dial outline will be
  294.         displayed with.
  295. Experiment with the different tool types to satisfy your personal taste.
  296. @endnode
  297. @node menus "Menu info..."
  298. -------------
  299. SClock menus:
  300. -------------
  301. If you activate the clock window and press the right mouse button
  302. (menu button), the SClock menus will appear.
  303. They are:
  304. ---------
  305.     * Project/About [Right Amiga ?]
  306.         Upon selecting this menu item, a window will appear
  307.         that contains info about SClock.
  308.     * Project/Quit [Right Amiga Q]
  309.         Selecting this quits SClock, (the clock window will close
  310.         and all used resources will be freed!! (I hope)).
  311.     * Settings/Font [Right Amiga F]
  312.         Selecting this menu item enables you to select a new font
  313.         that will be used to display the time/date text.
  314.         The Asl Font requester is used to display the different
  315.         fonts available.
  316.         If you select "OK", the clock window will close, and 
  317.         then re-open, with the new font.
  318.         If you select "Cancel", the old font will be used.
  319.         This menu item is only available when the "DIGITAL"
  320.         clock display is used.
  321.     * Settings/Backdrop [Right Amiga B]
  322.         Selecting this menu item enables you to select a new
  323.         backdrop that will be used as a background picture in 
  324.         the clock display.
  325.         The Asl File requester is used to display the different
  326.         backdrops available (only the picture file types that you
  327.         have datatypes for will be displayed!!!).
  328.         If you select "OK", the clock window will close, and 
  329.         then re-open, with the new backdrop.
  330.         If you select "Cancel", the old backdrop will be used.
  331.     * Settings/Save Settings [Right Amiga S]
  332.         Selecting this menu item will snapshot the current window
  333.         position, selected font and font size and or backdrop
  334.         picture, and save these settings in the "SClock.info" icon file
  335.         (Edit it and see!!)..
  336. @endnode
  337. @node errors "Error info..."
  338. -------
  339. Errors:
  340. -------
  341. SClock will put up different requesters when it encounters
  342. problems, and I hope that the displayed messages will clarify what
  343. went wrong.
  344. If you have enabled the "SHOWDATE" option and you select a LARGE
  345. font (75-128 pts), SClock will display a message that says that
  346. the window is to large, and that it will be truncated.  You will
  347. now be able to only see the clock as long as the font makes the
  348. window to large.  But at the moment you select a font that makes
  349. it possible for the window to fit into the current screen, the
  350. date information will be displayed again.
  351. @endnode
  352. @node misc "Misc..."
  353. -----------
  354. Misc stuff:
  355. -----------
  356. The number of configuration combinations you can achieve, makes it
  357. possible to make a lot of different "looks".  And don't hesitate
  358. to experiment with the different tool types to make it appear
  359. just as YOU want it!!
  360. Another thing that I just want to mention is that SClock uses less
  361. CPU time than any other clock I have seen so far.  (Atleast the
  362. ones that are system friendly...)
  363. @endnode
  364. @node Source
  365. -------------------
  366. SClock Source code:
  367. -------------------
  368. Since it only took a couple of days to write this program, I though
  369. that I might release the source code as well.
  370. It's not well documented (if documented at all), and not really
  371. that well written.
  372. To compile it you will need SAS/C 6.0 (preferably SAS/C 6.3).
  373. @endnode
  374. @node last "Last word..."
  375. -------------------
  376. Last but not least:
  377. -------------------
  378. This version of SClock was written on an A4000-030 (Standard eqpt),
  379. using the following tools:
  380.     * SAS/C 6.5         - The best (and only).
  381.     * CygnusEd V3.5     - Yeah... I need speed!!!
  382.     * MakeIndex         - (System function/struct lookup system for CEd).
  383.     * DOpus V4.10       - The ultimate DIR util...
  384. ------------------------
  385. Credits 'n' other stuff:
  386. ------------------------
  387. Here are the usual credits............
  388. Thanks to:
  389. ----------
  390.     * Lars Hamre      - The guy that wanted this program in the first place
  391.     * Anders Hamre    - For seeing and liking, bass, and good times
  392.     * Kim Jensen      - For just being Kim.
  393.     * Henning H.      - The PC freak of this century (maker of SBStudio).
  394.     * Stig J.         - For having a drivers licence, playing the bass-guitar,
  395.                         and generally being a nice fellow
  396.     * Arild Skullerud - For painting MUI style icons, and converting the
  397.                         DOC's into an AmigaGuide document.
  398.     * Atle Schulstad  - For.......????
  399.     * Per Tore        - For 
  400. re Per Tore!! >B^P
  401.       Tor Einar Jarnbjo, Morten W. Lund, 
  402. ystein Hungerholt (sound friend),
  403.       Amiga Forum (the only serious alternative),
  404.       Commodore (for not leaving us, yet!), etc........
  405.     * With inspiration from:
  406.         Genesis, Yes, ELP, Fish, Marillion, Primus, Rush, Brand-X,
  407.         King Crimson, Sylvian/Fripp, Percy Jones, Allan Holdsworth,
  408.         Mick Karn....
  409.         
  410.         Greetings to all fellow Prog Rockers out there, we are a
  411.         dying breed.
  412. I hope you find this program useful....
  413. If you want to contact me, write to:
  414. @{b}@{i}Rune Johnsrud @{ui}@{ub}
  415. Skogveien 16
  416. 2010 STR
  417. NORWAY
  418. (Sorry, no BBS numbers, EMAIL, etc.....)
  419. @endnode
  420. @node readme "Readme file..."
  421. ----------
  422. @{b}IMPORTANT:@{ub}
  423. ----------
  424. The author of this program is not in any way responsible for any
  425. damage caused by this software WHAT SO EVER!!!
  426. This version of SClock (and it's source code) is FREEWARE, so you
  427. can give it to anyone you want.  It should be distributed as
  428. FREEWARE, and anyone can include it in their PD library (or
  429. something similar), as long as they charge only a minor fee for
  430. copying, and as long as all the files in the archive accompany it
  431. (and the archive contents remains unchanged!!!).
  432. Fred Fish is also allowed to include this program in his excellent
  433. PD library.
  434. Computer magazines and other computer publications are NOT allowed
  435. to include it with their product without my written permission!!!!
  436. -----------------
  437. What is SClock??:
  438. -----------------
  439. SClock is another small clock utility, but it's a bit more special
  440. than any others that I have encountered before.
  441. -------------------------------
  442. What do you need to use SClock:
  443. -------------------------------
  444. You will need:
  445.   * One (or more) Amiga(s) (!)
  446.   * A MC68020 processor (or higher),
  447.   * At least Kickstart V3.0 (V39) (or higher).
  448. Things you DON'T really need:
  449.   * Some nice fonts
  450.   * Some nice IFF/GIF/BMP/JPEG/PCX pictures...
  451. For more information, read the SClock.DOC file!!!!!!
  452. Spread and enjoy!!!!!!!!!!!!!!!!!
  453. @endnode
  454. @node sc_tools "SClock tooltypes detailed list..."
  455. ***********************************
  456. SClock V1.72 Icon tool types table:
  457. ***********************************
  458. -------------------------------------------------------------------------------
  459. Name:               Type:       Min:    Max:    Default:        Applicabilty:
  460. -------------------------------------------------------------------------------
  461. DONOTWAIT           BOOLEAN     -       -       TRUE            Workbench
  462. PUBSCREEN           STRING      -       -       "Workbench"     All
  463. CLOCKTYPE           STRING      -       -       "ANALOG"        All
  464. TOPPOS              NUMBER      0       32000   0               All
  465. LEFTPOS             NUMBER      0       32000   0               All
  466. WIDTH               NUMBER      50      32000   100             Analog      *
  467. HEIGHT              NUMBER      50      32000   100             Analog      *
  468. FONTNAME            STRING      -       -       "topaz.font"    Digital
  469. FONTSIZE            NUMBER      1       127     8               Digital
  470. BACKDROP            STRING      -       -       ""              Analog
  471. SHOWDATE            BOOLEAN     -       -       FALSE           Digital     *
  472. SHOWSEC             BOOLEAN     -       -       FALSE           All
  473. TEXTPEN             NUMBER      0       256     2               All         *
  474. BGPEN               NUMBER      0       256     3               All         *
  475. EDGEBEVEL           BOOLEAN     -       -       -               All
  476. SHINEPEN            NUMBER      0       256     2               All         *
  477. SHADOWPEN           NUMBER      0       256     1               All         *
  478. DATEFORMAT          NUMBER      0       3       0               Digital     *
  479. DATESEPARATOR       CHAR        -       -       "."             Digital     *
  480. DATESPACING         NUMBER      0       32000   3               Digital     *
  481. TIMESEPARATOR       CHAR        -       -       ":"             Digital     *
  482. EDGESPACING         NUMBER      0       32000   5               Analog      *
  483. MINSMALLPEN         NUMBER      0       256     -               Analog
  484. MINLARGEPEN         NUMBER      0       256     -               Analog
  485. SECPEN              NUMBER      0       256     -               Analog
  486. MINPEN              NUMBER      0       256     -               Analog
  487. HOURPEN             NUMBER      0       256     -               Analog
  488. MINXSCALE           NUMBER      1       32000   -               Analog
  489. MINYSCALE           NUMBER      1       32000   -               Analog
  490. PLACECLOCK          BOOLEAN     -       -       FALSE           Analog
  491. CLOCKTOP            NUMBER      0       32000   -               Analog
  492. CLOCKLEFT           NUMBER      0       32000   -               Analog
  493. CLOCKWIDTH          NUMBER      50      32000   -               Analog
  494. CLOCKHEIGHT         NUMBER      50      32000   -               Analog
  495. SHOWDIAL            BOOLEAN     -       -       -               Analog
  496. DIALOUTILINEPEN     NUMBER      0       256     -               Analog
  497. DIALPEN             NUMBER      0       256     -               Analog
  498. BACKDROPWIN         BOOLEAN     -       -       FALSE           All
  499. AUTOSIZE            BOOLEAN     -       -       FALSE           All
  500. LOCKPOS             BOOLEAN     -       -       FALSE           All
  501. "*" = Not yet applicable, or has no function because of overiding settings.
  502. "+" = Not yet implemented, or does not function properly.
  503. @endnode
  504.